YAyampi
Público - Catálogo

Listar Coleções de uma loja

Changed on

Retorna as Informações públicas das coleções

get/{alias}/public/catalog/collections{?id[]={collectionId}}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/public/catalog/collections{?id[]={collectionId}}
  • Auth
    none required

Path parameters

aliasstring required

Alias da loja

Query parameters

id[]string required

ID da coleção - exemplo: /{alias}/public/catalog/collections?id[]=5287&id[]=7821

Response

Retorna as Informações públicas de uma Coleção

idinteger

ID da coleção.

parent_idinteger

ID da coleção pai, quando a coleção for uma subcoleção.

activeboolean

Indica se a coleção está ativa e visível na loja.

show_bannersboolean

Indica se os banners vinculados à coleção são exibidos na página dela.

featuredboolean

Indica se a coleção é destacada na navegação da loja.

is_promotionalboolean

Indica se a coleção é promocional, com período de vigência definido por start_at e end_at.

namestring

Nome da coleção.

visible_productsinteger

Quantidade de produtos exibidos na vitrine da coleção.

homeboolean

Indica se a coleção é exibida na página inicial da loja.

expiredboolean

Indica se a data de término da coleção já passou.

slugstring

Slug da coleção, usado na composição da URL.

descriptionstring

Texto descritivo exibido na página da coleção.

seo_titlestring

Título usado para SEO (tag title) da página da coleção.

seo_keywordsstring

Palavras-chave usadas para SEO da página da coleção.

seo_descriptionstring

Descrição usada para SEO (meta description) da página da coleção.

pathstring

Caminho relativo para o recurso.

expire_instring

Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos').

total_productsinteger

Número total de produtos relacionados ao recurso.

restricedboolean

Indica se a coleção tem regras de restrição de produtos (inclusão ou exclusão por marca e categoria).

urlstring uri

URL completa da página da coleção na loja.

stopwatchstring

Tipo da contagem regressiva exibida na coleção: daily (reinicia todo dia) ou expiration_date (conta até a data de término).

stopwatch_expires_instring

Data e hora em que a contagem regressiva termina: o fim do dia atual quando stopwatch for daily, ou a data de término da coleção.

Example response

{
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "products": [
    {
      "data": {
        "id": 17790530,
        "sku_id": 262573372,
        "has_variations": true,
        "name": "GTA V Premium 10Uni.",
        "slug": "gta-v-premium-10uni",
        "sku": "GQVQLNP34,69SQH26GU,QWNVUZHMQ,EPSHDEZPT,K89BHGYNV,SKU-TEST-API,LLKUD2KAM,E7K48R248",
        "rating": "4.7",
        "total_approved_reviews": 3,
        "url": "https://www.mytems.com/gta-v-premium-10uni/p",
        "url_path": "/gta-v-premium-10uni/p",
        "use_different_images": 1,
        "brand": {
          "data": {
            "id": 733502,
            "name": "Rockstar Games"
          }
        },
        "images": {
          "data": [
            {
              "url": "https://images.yampi.me/assets/stores/mytems/uploads/images/gta-v-premium-10uni-ps5-dvd-67939caf6a3ac-large.jpg"
            }
          ]
        },
        "prices": {
          "data": {
            "currency": "R$",
            "price_cost_formated": "R$ 0,00",
            "price": 1,
            "price_formated": "R$ 1,00",
            "base_amount": "1",
            "fraction_amount": "00",
            "price_sale": 1.11,
            "price_sale_formated": "R$ 1,11",
            "price_discount_formated": "R$ 0,00",
            "has_promotion": true,
            "percent_discount": 9.91,
            "billet": {
              "price": 1,
              "price_formated": "R$ 1,00",
              "base_amount": "1",
              "fraction_amount": "00",
              "discount_percent": "0.00",
              "discount_text": "R$ 1,00 à vista com 0.00% de desconto"
            },
            "pix": {
              "price": 0.9,
              "price_formatted": "R$ 0,90",
              "base_amount": "0",
              "fraction_amount": "90",
              "discount_value": 0.1,
              "discount_percent": "10.00",
              "discount_text": "R$ 0,90 à vista com 10.00% de desconto"
            },
            "installments": {
              "data": {
                "max_installment": 1,
                "max_installment_value": 1.11,
                "amount": 1.11,
                "text": "1x de R$ 1,11 sem juros",
                "text_with_tax": "1x de R$ 1,11"
              }
            }
          }
        },
        "flags": {
          "data": [
            {
              "id": 24875,
              "name": "Pronta Entrega",
              "slug": "pronta-entrega",
              "text_color": "#333333",
              "background_color": "#D0D0D0"
            }
          ]
        },
        "variations": {
          "data": [
            {
              "id": 1033792,
              "name": "MIDIA",
              "values": {
                "data": [
                  {
                    "id": 15963676,
                    "value": "Blu-Ray",
                    "blocked_sale": 1
                  }
                ]
              }
            }
          ]
        },
        "skus": {
          "data": [
            {
              "id": 262573372,
              "product_id": 17790530,
              "sku": "69SQH26GU",
              "title": "GTA V Premium 10Uni. PS5 DVD",
              "variations": [
                {
                  "name": "PLATAFORMA",
                  "id": 1005560,
                  "value": "PS5",
                  "value_id": 15543722
                }
              ],
              "days_availability_formated": "Imediata",
              "price_sale": 1.11,
              "combinations": "15543722-15963677",
              "stock_status": "in_stock",
              "barcode": "7891234567895",
              "purchase_url": "https://mytems.pay.yampi.com.br/r/IG65R4X4LD",
              "prices": {
                "data": {
                  "currency": "R$",
                  "price_cost_formated": "R$ 0,00",
                  "price": 1,
                  "price_formated": "R$ 1,00",
                  "base_amount": "1",
                  "fraction_amount": "00",
                  "price_sale": 1.11,
                  "price_sale_formated": "R$ 1,11",
                  "price_discount_formated": "R$ 0,00",
                  "has_promotion": true,
                  "percent_discount": 9.91,
                  "billet": {
                    "price": 1,
                    "price_formated": "R$ 1,00",
                    "base_amount": "1",
                    "fraction_amount": "00",
                    "discount_percent": "0.00",
                    "discount_text": "R$ 1,00 à vista com 0.00% de desconto"
                  },
                  "pix": {
                    "price": 0.9,
                    "price_formatted": "R$ 0,90",
                    "base_amount": "0",
                    "fraction_amount": "90",
                    "discount_value": 0.1,
                    "discount_percent": "10.00",
                    "discount_text": "R$ 0,90 à vista com 10.00% de desconto"
                  }
                }
              },
              "images": {
                "data": [
                  {
                    "url": "https://images.yampi.me/assets/stores/mytems/uploads/images/gta-v-premium-10uni-ps5-dvd-6793a15012988-large.jpg"
                  }
                ]
              },
              "customizations": {
                "data": [
                  {
                    "id": 5363,
                    "name": "nome",
                    "type": "input",
                    "max_chars": 8,
                    "allowed_values": "all",
                    "created_at": {
                      "date": "2000-08-17 10:24:24",
                      "timezone_type": 3,
                      "timezone": "America/Sao_Paulo"
                    },
                    "updated_at": {
                      "date": "2000-08-17 10:24:24",
                      "timezone_type": 3,
                      "timezone": "America/Sao_Paulo"
                    },
                    "total_products": 3,
                    "products_ids": [
                      9828573,
                      18340521,
                      17790530
                    ]
                  }
                ]
              }
            }
          ]
        },
        "categories": {
          "data": [
            {
              "id": 1534214,
              "name": "JOGOS",
              "slug": "jogos",
              "url_path": "/jogos"
            }
          ]
        },
        "breadcrumbs": {
          "data": [
            {
              "id": 1534214,
              "name": "JOGOS",
              "url_path": "/jogos?sort_by=best_sellers"
            }
          ]
        }
      }
    }
  ],
  "banners": [
    {
      "data": [
        {
          "id": 119474,
          "type": "image",
          "active": true,
          "home": true,
          "name": "Top-banner",
          "slug": "top-banner",
          "image_url": "//images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg",
          "start_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "end_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "first_banner": {
            "id": 119474,
            "image": "//images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg"
          },
          "dimensions": {
            "desktop": {
              "width": "1186.00",
              "height": "441.00"
            },
            "mobile": {
              "width": "0.00",
              "height": "0.00"
            }
          },
          "product": {
            "data": [
              {
                "data": {
                  "id": 17790530,
                  "name": "GTA V Premium 10Uni.",
                  "slug": "gta-v-premium-10uni",
                  "rating": "4.7",
                  "url": "https://www.mytems.com/gta-v-premium-10uni/p",
                  "url_path": "/gta-v-premium-10uni/p",
                  "brand": {
                    "data": {
                      "id": 733502,
                      "name": "Rockstar Games"
                    }
                  },
                  "images": {
                    "data": [
                      {
                        "url": "https://images.yampi.me/assets/stores/mytems/uploads/images/gta-v-premium-10uni-ps5-dvd-67939caf6a3ac-large.jpg"
                      }
                    ]
                  },
                  "prices": {
                    "data": {
                      "currency": "R$",
                      "price": 1,
                      "price_formated": "R$ 1,00",
                      "price_sale": 1.11,
                      "price_sale_formated": "R$ 1,11",
                      "has_promotion": true,
                      "percent_discount": 9.91
                    }
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

Changes